eeprom15 2.2.1
Loading...
Searching...
No Matches
eeprom15.h File Reference

This file contains API for EEPROM 15 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  eeprom15_t
 EEPROM 15 Click context object. More...
struct  eeprom15_cfg_t
 EEPROM 15 Click configuration object. More...

Macros

#define EEPROM15_REG_RW_EE_MEMORY   0x50
 EEPROM 15 device address setting.
#define EEPROM15_REG_RW_WP_BLOCK_0   0x31
#define EEPROM15_REG_RW_WP_BLOCK_1   0x34
#define EEPROM15_REG_RW_WP_BLOCK_2   0x35
#define EEPROM15_REG_RW_WP_BLOCK_3   0x30
#define EEPROM15_REG_CLEAR_ALL_WP   0x33
#define EEPROM15_REG_SET_PAGE_ADDR_0   0x36
#define EEPROM15_REG_SET_PAGE_ADDR_1   0x37
#define EEPROM15_REG_READ_PAGE_ADDR   0x36
#define EEPROM15_MEM_PAGE_BITMASK   0xF0
 EEPROM 15 memory size setting.
#define EEPROM15_MEM_PAGE_SIZE   16
#define EEPROM15_MEM_BANK_SIZE   256
#define EEPROM15_BANK_SEL_0   0x00
 EEPROM 15 bank selection setting.
#define EEPROM15_BANK_SEL_1   0x01
#define EEPROM15_WP_BLOCK_SEL_0   0x00
 EEPROM 15 wp block selection setting.
#define EEPROM15_WP_BLOCK_SEL_1   0x01
#define EEPROM15_WP_BLOCK_SEL_2   0x02
#define EEPROM15_WP_BLOCK_SEL_3   0x03
#define EEPROM15_ADDRESS_A2A1A0_000   0x00
 EEPROM 15 device address setting via onboard A2-A1-A0 pins.
#define EEPROM15_ADDRESS_A2A1A0_001   0x01
#define EEPROM15_ADDRESS_A2A1A0_010   0x02
#define EEPROM15_ADDRESS_A2A1A0_011   0x03
#define EEPROM15_ADDRESS_A2A1A0_100   0x04
#define EEPROM15_ADDRESS_A2A1A0_101   0x05
#define EEPROM15_ADDRESS_A2A1A0_110   0x06
#define EEPROM15_ADDRESS_A2A1A0_111   0x07
#define EEPROM15_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  eeprom15_return_value_t { EEPROM15_OK = 0 , EEPROM15_ERROR = -1 }
 EEPROM 15 Click return value data. More...

Functions

void eeprom15_cfg_setup (eeprom15_cfg_t *cfg)
 EEPROM 15 configuration object setup function.
err_t eeprom15_init (eeprom15_t *ctx, eeprom15_cfg_t *cfg)
 EEPROM 15 initialization function.
err_t eeprom15_write_memory (eeprom15_t *ctx, uint8_t address, uint8_t *data_in, uint8_t len)
 EEPROM 15 Write Memory function.
err_t eeprom15_read_memory (eeprom15_t *ctx, uint8_t address, uint8_t *data_out, uint16_t len)
 EEPROM 15 Read Memory function.
void eeprom15_set_wp_pin (eeprom15_t *ctx, uint8_t state)
 EEPROM 15 Set Write Protection Pin function.
err_t eeprom15_select_bank (eeprom15_t *ctx, uint8_t bank_sel)
 EEPROM 15 Select Memory Bank function.
err_t eeprom15_set_wp_block (eeprom15_t *ctx, uint8_t block_num)
 EEPROM 15 Set Write Protection Block function.
err_t eeprom15_clear_wp (eeprom15_t *ctx)
 EEPROM 15 Clear Write Protection function.

Detailed Description

This file contains API for EEPROM 15 Click Driver.

Enumeration Type Documentation

◆ eeprom15_return_value_t

EEPROM 15 Click return value data.

Predefined enum values for driver return values.

Enumerator
EEPROM15_OK 
EEPROM15_ERROR